getalloweddata¶

You can perform five API actions using this endpoint. username and secret_key are the two mandatory parameters for using this endpoint. You require these parameters for Authorization and Authentication. There is an additional parameter type which distinguishes the API action.

API Action	Request Type	Additional Parameter	Parameter Value
Getting User Timezone	POST	type	user_preference
Getting LogPoints	POST	type	loginspects
Getting Repos	POST	type	logpoint_repos
Getting Devices	POST	type	devices
Getting LiveSearches	POST	type	livesearches

Getting User Timezone¶

Retrieve timezone and date and time format.

POST

https://LogPoint-IP/getalloweddata

Parameter	Value Type	Description
username	String	A LogPoint username
secret_key	String	Secret key of LogPoint. Refer to Finding the Access Key.
type	String	An identifier for the API action. Its value must be user_preference.

Request Example¶

params = {
        "username" : "John",
        "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
        "type" : "user_preference"
        }

Success Response¶

{
        "success": true,
        "timezone": "UTC",
        "date_format": "%Y/%m/%d",
        "hour_format": "24 Hour"
}

Getting LogPoints¶

Retrieve name and IP address of all the LogPoints configured in a distributed setup.

POST

https://LogPoint-IP/getalloweddata

Parameter	Value Type	Description
username	String	A LogPoint username
secret_key	String	Secret key of LogPoint. Refer to Finding the Access Key.
type	String	An identifier for the API action. Its value must be loginspects.

Request Example¶

params = {
        "username" : "John",
        "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
        "type" : "loginspects"
        }

Success Response¶

{
        "success": true,
        "allowed_loginspects": [
        {
                "name": "LogPoint",
                "ip": "127.0.0.1"
        }
        ]
}

Getting Repos¶

Retrieve name and IP address of all the repos configured in a LogPoint.

POST

https://LogPoint-IP/getalloweddata

Parameter	Value Type	Description
username	String	A LogPoint username
secret_key	String	Secret key of LogPoint. Refer to Finding the Access Key.
type	String	An identifier for the API action. Its value must be logpoint_repos.

Request Example¶

params = {
        "username" : "John",
        "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
        "type" : "logpoint_repos"
        }

Success Response¶

{
        "success": true,
        "allowed_repos": [
                {
                        "repo": "default",
                        "address": "127.0.0.1:5504/default"
                },
                {
                        "repo": "_logpoint",
                        "address": "127.0.0.1:5504/_logpoint"
                }
                ....
                ....
                ],
        "logpoint": [
                {
                        "name": "LogPoint",
                        "ip": "127.0.0.1"
                }
        ]
}

Getting Devices¶

Retrieve name and IP address of all the devices configured in a LogPoint.

POST

https://LogPoint-IP/getalloweddata

Parameter	Value Type	Description
username	String	A LogPoint username
secret_key	String	Secret key of LogPoint. Refer to Finding the Access Key.
type	String	An identifier for the API action. Its value must be devices.

Request Example¶

params = {
        "username" : "John",
        "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
        "type" : "devices"
        }

Success Response¶

{
        "success": true,
        "allowed_devices": [
                {
                        "127.0.0.1/127.0.0.1": "localhost",
                        "127.0.0.1/::1": "localhost",
                        "127.0.0.1/10.45.3.107": "107"
                }
                ],
        "logpoint": [
                {
                        "name": "LogPoint",
                        "ip": "127.0.0.1"
                }
        ]
}

Getting LiveSearches¶

Retrieve information related to the live searches performed for dashboards and alerts.

POST

https://LogPoint-IP/getalloweddata

Parameter	Value Type	Description
username	String	A LogPoint username
secret_key	String	Secret key of LogPoint. Refer to Finding the Access Key.
type	String	An identifier for the API action. Its value must be livesearches.

Request Example¶

params = {
        "username" : "John",
        "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
        "type" : "livesearches"
        }

Success Response¶

{
        "success": true,
        "livesearches": [
                {
                        "searchname": "device_ip",
                        "description": "",
                        "query": "| chart count() by device_ip",
                        "query_info": {
                                "fieldsToExtract": [],
                                "aliases": [
                                        "count()"
                                ],
                                "success": true,
                                "query_filter": "",
                                "columns": [
                                        "count()"
                                ],
                                "query_type": "chart",
                                "lucene_query": "",
                                "grouping": [
                                        "device_ip"
                                ]
                        },
                        "timerange_day": 0,
                        "timerange_hour": 0,
                        "timerange_minute": 1,
                        "timerange_second": 0,
                        "limit": 100,
                        "tid": "",
                        "generated_by": "dashboard",
                        "vid": "",
                        "flush_on_trigger": false,
                        "life_id": "3287dec3b4012b50f63e15fd6cbe6f77dc56aa4b"
                        }
                ]
}

Helpful?